<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Aria: ArMapSupplementInterface Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Aria
   &#160;<span id="projectnumber">2.9.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classArMapSupplementInterface.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classArMapSupplementInterface-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ArMapSupplementInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Methods related to miscellaneous extra data in an <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map.  
 <a href="classArMapSupplementInterface.html#details">More...</a></p>

<p><code>#include &lt;ArMapInterface.h&gt;</code></p>

<p>Inherited by <a class="el" href="classArMapInterface.html">ArMapInterface</a>, and <a class="el" href="classArMapSupplement.html">ArMapSupplement</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a75e349954bd7cab8ab02cbef2477afbb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75e349954bd7cab8ab02cbef2477afbb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapSupplementInterface.html#a75e349954bd7cab8ab02cbef2477afbb">ArMapSupplementInterface</a> ()</td></tr>
<tr class="memdesc:a75e349954bd7cab8ab02cbef2477afbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a75e349954bd7cab8ab02cbef2477afbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af88e4a2570cad93de78b6ffaea8a79d8"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapSupplementInterface.html#af88e4a2570cad93de78b6ffaea8a79d8">getOriginAltitude</a> ()=0</td></tr>
<tr class="memdesc:af88e4a2570cad93de78b6ffaea8a79d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the altitude of the origin; valid only if hasOriginLatLongAlt returns true.  <a href="#af88e4a2570cad93de78b6ffaea8a79d8">More...</a><br /></td></tr>
<tr class="separator:af88e4a2570cad93de78b6ffaea8a79d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40cf90a392ae8ef708c9ef6de2a958d5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40cf90a392ae8ef708c9ef6de2a958d5"></a>
virtual <a class="el" href="classArPose.html">ArPose</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapSupplementInterface.html#a40cf90a392ae8ef708c9ef6de2a958d5">getOriginLatLong</a> ()=0</td></tr>
<tr class="memdesc:a40cf90a392ae8ef708c9ef6de2a958d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the latitude/longitude origin; valid only if hasOriginLatLongAlt returns true. <br /></td></tr>
<tr class="separator:a40cf90a392ae8ef708c9ef6de2a958d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e20fd22020e562a213b1bd572ff6557"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e20fd22020e562a213b1bd572ff6557"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapSupplementInterface.html#a8e20fd22020e562a213b1bd572ff6557">hasOriginLatLongAlt</a> ()=0</td></tr>
<tr class="memdesc:a8e20fd22020e562a213b1bd572ff6557"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether this map has an origin specified in latitude/longitude (and altitude) <br /></td></tr>
<tr class="separator:a8e20fd22020e562a213b1bd572ff6557"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3019f796bc838b1d41a525f710ce9e2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapSupplementInterface.html#af3019f796bc838b1d41a525f710ce9e2">setOriginLatLongAlt</a> (bool hasOriginLatLong, const <a class="el" href="classArPose.html">ArPose</a> &amp;originLatLong, double altitude, <a class="el" href="classArMapChangeDetails.html">ArMapChangeDetails</a> *changeDetails=NULL)=0</td></tr>
<tr class="memdesc:af3019f796bc838b1d41a525f710ce9e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the latitude/longitude and altitude of the origin.  <a href="#af3019f796bc838b1d41a525f710ce9e2">More...</a><br /></td></tr>
<tr class="separator:af3019f796bc838b1d41a525f710ce9e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a718ef19d1c4028465dd45808e9f01427"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapSupplementInterface.html#a718ef19d1c4028465dd45808e9f01427">writeSupplementToFunctor</a> (<a class="el" href="classArFunctor1.html">ArFunctor1</a>&lt; const char * &gt; *functor, const char *endOfLineChars)=0</td></tr>
<tr class="memdesc:a718ef19d1c4028465dd45808e9f01427"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes the supplemental data to the given functor.  <a href="#a718ef19d1c4028465dd45808e9f01427">More...</a><br /></td></tr>
<tr class="separator:a718ef19d1c4028465dd45808e9f01427"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2a0de4d8b9a9eab364b18e5d1baf05d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2a0de4d8b9a9eab364b18e5d1baf05d"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapSupplementInterface.html#ad2a0de4d8b9a9eab364b18e5d1baf05d">~ArMapSupplementInterface</a> ()</td></tr>
<tr class="memdesc:ad2a0de4d8b9a9eab364b18e5d1baf05d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:ad2a0de4d8b9a9eab364b18e5d1baf05d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Methods related to miscellaneous extra data in an <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map. </p>
<p><a class="el" href="classArMapSupplementInterface.html" title="Methods related to miscellaneous extra data in an Aria map. ">ArMapSupplementInterface</a> is basically a repository for any pieces of data that do not fit in the other categories (i.e. scan data, map objects, or info). It currently stores the optional latitude/longitude information. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af88e4a2570cad93de78b6ffaea8a79d8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual double ArMapSupplementInterface::getOriginAltitude </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the altitude of the origin; valid only if hasOriginLatLongAlt returns true. </p>
<dl class="section return"><dt>Returns</dt><dd>double the altitude (in meters) of the origin </dd></dl>

<p>Implemented in <a class="el" href="classArMapSupplement.html#a5801da979e0f61f17d5f817077c1a565">ArMapSupplement</a>.</p>

</div>
</div>
<a class="anchor" id="af3019f796bc838b1d41a525f710ce9e2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ArMapSupplementInterface::setOriginLatLongAlt </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>hasOriginLatLong</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classArPose.html">ArPose</a> &amp;&#160;</td>
          <td class="paramname"><em>originLatLong</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>altitude</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classArMapChangeDetails.html">ArMapChangeDetails</a> *&#160;</td>
          <td class="paramname"><em>changeDetails</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Sets the latitude/longitude and altitude of the origin. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">hasOriginLatLong</td><td>a bool set to true if the map has latitude/longitude information for the origin </td></tr>
    <tr><td class="paramname">originLatLong</td><td>the <a class="el" href="classArPose.html" title="Represents an x, y position with an orientation. ">ArPose</a> that specifies the latitude/longitude of the origin </td></tr>
    <tr><td class="paramname">altitude</td><td>the double altitude (in meters) of the origin </td></tr>
    <tr><td class="paramname">changeDetails</td><td>a pointer to the optional <a class="el" href="classArMapChangeDetails.html" title="Helper class used to track changes to an Aria map. ">ArMapChangeDetails</a> in which to store a description of the changes to the scan data; if NULL then the changes are not tracked. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a718ef19d1c4028465dd45808e9f01427"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ArMapSupplementInterface::writeSupplementToFunctor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classArFunctor1.html">ArFunctor1</a>&lt; const char * &gt; *&#160;</td>
          <td class="paramname"><em>functor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>endOfLineChars</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Writes the supplemental data to the given functor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">functor</td><td>the <a class="el" href="classArFunctor1.html" title="Base class for functors with 1 parameter. ">ArFunctor1</a> to which to write the supplemental data (as text lines) </td></tr>
    <tr><td class="paramname">endOfLineChars</td><td>the const char * string to be appended to the end of each text line </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ArMapInterface_8h.html">ArMapInterface.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classArMapSupplementInterface.html">ArMapSupplementInterface</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
